Skip to content

docs: Add Python version flag to uvx instructions#45

Merged
Aaron ("AJ") Steers (aaronsteers) merged 3 commits intomainfrom
devin/1762372957-add-uvx-docs
Nov 5, 2025
Merged

docs: Add Python version flag to uvx instructions#45
Aaron ("AJ") Steers (aaronsteers) merged 3 commits intomainfrom
devin/1762372957-add-uvx-docs

Conversation

@aaronsteers
Copy link
Contributor

@aaronsteers Aaron ("AJ") Steers (aaronsteers) commented Nov 5, 2025 •
edited by coderabbitai bot
Loading

docs: Add Python version flag to uvx instructions

Summary

Updates the README's uvx command to include the -p 3.13 flag, ensuring users run the application with Python 3.13 as required by the project. Adds a note explaining why the Python version flag is needed.

This documentation update aligns with the recently merged PR #44 which enabled uvx support for running the application directly from GitHub.

Review & Testing Checklist for Human

  • Verify the uvx command works: Run uvx -p 3.13 --from git+https://github.com/airbytehq/agentic-connector-builder-webapp agentic-connector-builder-webapp from a clean directory and confirm the app starts successfully
  • Confirm Python version requirement: Verify that Python 3.13 is indeed required (check pyproject.toml requires-python field)

Notes

  • This is a minimal documentation update to improve the quick start instructions
  • The -p 3.13 flag ensures uvx uses Python 3.13, which is required per pyproject.toml
  • No code changes, only documentation

Requested by: AJ Steers (Aaron ("AJ") Steers (@aaronsteers))
Devin session: https://app.devin.ai/sessions/c76714d123fd462bbc34ad4817159623

Summary by CodeRabbit

@devin-ai-integration @aaronsteers
docs: Add Python version flag to uvx instructions
c150120 
- Add -p 3.13 flag to uvx command for Python 3.13 requirement
- Add note explaining the Python version requirement

Co-Authored-By: AJ Steers <aj@airbyte.io>
Copilot AI review requested due to automatic review settings November 5, 2025 20:03
@devin-ai-integration
Copy link
Contributor

devin-ai-integration bot commented Nov 5, 2025

Original prompt from AJ Steers 
@Devin - Can you give me a uvx command to run the agentic connector builder webapp from main branch?
Thread URL: https://airbytehq-team.slack.com/archives/D089P0UPVT4/p1762298143001619

@devin-ai-integration
Copy link
Contributor

devin-ai-integration bot commented Nov 5, 2025

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 5, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

Updated README.md Quick Start to change the uvx install command to include an explicit Python version flag (--python=3.13) and a clarifying note about requiring that flag for Python 3.13 compatibility.

Changes

Cohort / File(s) Summary
Documentation updates
README.md		 Replaced uvx Quick Start command to specify Python version: uvx --python=3.13 --from git+https://github.com/airbytehq/agentic-connector-builder-webapp agentic-connector-builder-webapp; added clarification about needing the flag for Python 3.13 compatibility.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2–3 minutes

  • Review focus: README.md change correctness (flag syntax and wording).
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch devin/1762372957-add-uvx-docs
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c150120 and e7c38c6.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI reviewed Nov 5, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the README documentation to specify Python 3.13 when running the application via uvx, ensuring users run with the correct Python version required by the project.

  • Adds the -p 3.13 flag to the uvx command
  • Includes an explanatory note about the Python version requirement

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

aaronsteers
Aaron ("AJ") Steers (aaronsteers) commented Nov 5, 2025
View reviewed changes
aaronsteers
Aaron ("AJ") Steers (aaronsteers) commented Nov 5, 2025
View reviewed changes
@aaronsteers Aaron ("AJ") Steers (aaronsteers) merged commit 49f413c into main Nov 5, 2025
8 checks passed
@aaronsteers Aaron ("AJ") Steers (aaronsteers) deleted the devin/1762372957-add-uvx-docs branch November 5, 2025 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

@aaronsteers Aaron ("AJ") Steers (aaronsteers)

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@aaronsteers